feat: example using hwi signing with #206

sdmg15 · 2025-04-10T14:42:59Z

Description

Integrates a new BDK signer using async-hwi.
The included example uses Bitbox02 but can be easily extended to use any other supported device.

Notes for reviewer

It's related to issue #20

Changelog notice

Checklists

All Submissions:

I've signed all my commits
I followed the contribution guidelines
I ran cargo fmt and cargo clippy before committing

notmandatory · 2025-04-21T23:50:12Z

Thanks for this! looks like a good simple example for using hwi-async with bdk_wallet. One FYI we are talking about removing signing from bdk_wallet and delegating it to the rust-bitcoin Psbt::sign function. How hard would it be to use hwi-async to just sign a Psbt ?

sdmg15 · 2025-04-23T12:03:36Z

async-hwi provides a function with the following signature

    async fn sign_tx(&self, tx: &mut Psbt) -> Result<(), Error>;

So I think after constructing the psbt we can just call that function and voila.

sdmg15 · 2025-04-23T12:08:40Z

examples/example_wallet_hwi_signer/src/main.rs

+
+    let _ = bb.register_wallet("test-wallet", descriptor).await.unwrap();
+
+    let bitbox_signer = HwiSigner::new(bb);


So at this level we can just call bibox_signer.sign(psbt) given that the psbt has been constructed with bdk_wallet or something else

Yes I think this is the right approach. Even though it makes the example much simpler it's still useful to show the end-to-end flow of using async-hwi to sign a psbt created with bdk_wallet::TxBuilder (and eventually the bdk_tx::TxBuilder).

Is it a good idea to add syncing wallet code in the example?
If not what's a good way of mocking the wallet with some utxos to sign?

sdmg15 · 2025-05-05T16:49:02Z

@notmandatory
Instead of syncing I "mocked" the wallet with some UTXOs since syncing isn't the goal of this example.

I also added a feature simulator when enabled for people that don't have a physical device connected but still want to run the example (Still need to add instructions on the readme on how to run)

Please let me know what you think

oleonardolima

Thanks for working on this one, I left a few comments and also would recommend squashing the commits into a single one and follow the https://www.conventionalcommits.org/en/v1.0.0/ (e.g chore(example): add example using `async-hwi`.

examples/example_wallet_hwi_signer/Cargo.toml

examples/example_wallet_hwi_signer/README.md

examples/example_wallet_hwi_signer/Cargo.toml

sdmg15 · 2025-05-21T13:21:27Z

Thanks for taking a look @oleonardolima. I've addressed your suggestions.

oleonardolima · 2025-05-23T18:03:40Z

Thanks for taking a look @oleonardolima. I've addressed your suggestions.

Thanks for the updates, I'll do a round of review and testing.

notmandatory · 2025-05-28T00:45:54Z

I recommend a rebase for this after the bdk_wallet 2.0 version is released.

oleonardolima · 2025-06-05T18:01:13Z

@sdmg15 You need to rebase to get latest updates and API changes from 2.0 release. I'm reviewing/testing it and it doesn't seem to work, as it's currently implemented the simulator/hw device it's not using the same wallet/descriptors, it should probably be imported in order to sign the PSBT tx by created by BDK wallet.

sdmg15 · 2025-06-05T19:44:51Z

Thanks for taking time for reviewing @oleonardolima

The simulator uses the following mnemonic (quoting the bitbox code):

/// BIP32 xprv from BIP39 mnemonic used by the simulator:
/// boring mistake dish oyster truth pigeon viable emerge sort crash wire portion cannon couple enact box walk height pull today solid off enable tide
pub const SIMULATOR_BIP32_XPRV: &str = "xprv9s21ZrQH143K2qxpAMxVdyeza5dUBxY11XbJ7eKvRF51sQyhiFXgmn4P4ALi3Nf6bcG8cmPDvMMEFiAVjtXsqeZ47PJfBJif7uSYycMsx9c";

The extended private key that I have in the code is: tprv8ZgxMBicQKsPdfCLpvozodGytD3gRUa1M5WQz4kNuDZVf1inhcsSHXRpyLWN3k3Qy3nucrzz5hw2iZiEs6spehpee2WxqfSi31ByRJEu4rZ which is derived from the mnemonic.

When you say it's not working do you encounter any error?

In non-simulator bdk wallet seems to still be using the descriptor of simulator which is one the thing to fix i think :)

sdmg15 · 2025-06-12T07:47:50Z

Updated the code to follow the new API and run another round of tests in simulator mode and everything seems ok. Let me know the issues you're running into @oleonardolima

tvpeter

Thank you @sdmg15 for working on this.

I have setup the bitbox simulator but it doesn't seem to connect and when I run the example with the simulator feature enabled, the version of bitbox API do breaks (shared in the comments).

The simulator runs on a docker container and exposes port 15423

Can you check if it is my setup that is not correct or you need to update the bitbox-api version?

Thank you.

tvpeter · 2025-07-15T13:47:56Z

examples/example_wallet_hwi_signer/Cargo.toml

+[dependencies]
+bdk_wallet = { path = "../../wallet", features = ["file_store"] }
+tokio = { version = "1", features = ["rt", "rt-multi-thread", "macros"] }
+bitbox-api = {version = "0.6.0", features = ["tokio"], optional = true}


This version of bitbox-api seems to be throwing errors at my end:

error[E0053]: method `read` has an incompatible type for trait --> /Users/vihigatyonum/.cargo/registry/src/index.crates.io-1949cf8c6b5b557f/bitbox-api-0.6.0/src/simulator.rs:45:1 | 45 | #[async_trait(?Send)] | ^^^^^^^^^^^^^^^^^^^^^ expected trait `std::future::Future<Output = Result<Vec<u8>, communication::Error>> + Send`, found trait `std::future::Future<Output = Result<Vec<u8>, communication::Error>>` |

Maybe you can consider updating.

Could you confirm to me your rustc version? I'm using rustc 1.85.0 (4d91de4e4 2025-02-17)

In the attached image I cleared everything with cargo clean and followed the steps written in the README.

Thank you @sdmg15 for responding. I have the same version, but I guess there is a mix-up somewhere that I need to figure out.

I am working on this issue on bdk-cli, when I am done, you might help review the PR. Thank you.

Alright no issue, we could sync up in a call if you want so that we can figure what's going on, I'm in the bdk discord @sdmg15 is my handle.

Alright, I will reach out. Thank you.

I have the same version, but I guess there is a mix-up somewhere that I need to figure out.

After our conversation and applying the bitbox-api v0.6.0 patch, it worked; however, async-hwi's latest version (0.0.28) still points to v0.6.0 of bitbox-api. So, a better approach might be to use only async-hwi, as it offers support for other hardware devices, not just bitbox.
Thank you

sdmg15 mentioned this pull request Apr 10, 2025

Create an example custom signer using hwi-async #20

Open

notmandatory added this to BDK Wallet Apr 21, 2025

notmandatory assigned sdmg15 Apr 21, 2025

notmandatory added the documentation Improvements or additions to documentation label Apr 21, 2025

notmandatory moved this to In Progress in BDK Wallet Apr 21, 2025

sdmg15 commented Apr 23, 2025

View reviewed changes

sdmg15 marked this pull request as ready for review May 9, 2025 07:26

oleonardolima reviewed May 19, 2025

View reviewed changes

sdmg15 force-pushed the master branch from 8dce5dc to 1fed8f8 Compare May 21, 2025 13:19

oleonardolima added this to the Wallet 2.1.0 milestone Jun 5, 2025

chore(example): add example using async-hwi

9e01268

sdmg15 force-pushed the master branch from 1fed8f8 to 9e01268 Compare June 12, 2025 07:42

ValuedMammal mentioned this pull request Jun 12, 2025

refactor(wallet)!: remove signers and it's APIs, relying on rust-bitcoin's Psbt::sign instead. #235

Draft

8 tasks

tvpeter suggested changes Jul 15, 2025

View reviewed changes


		let _ = bb.register_wallet("test-wallet", descriptor).await.unwrap();

		let bitbox_signer = HwiSigner::new(bb);

feat: example using hwi signing with #206

Are you sure you want to change the base?

feat: example using hwi signing with #206

Uh oh!

Conversation

sdmg15 commented Apr 10, 2025

Description

Notes for reviewer

Changelog notice

Checklists

All Submissions:

Uh oh!

notmandatory commented Apr 21, 2025

Uh oh!

sdmg15 commented Apr 23, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

notmandatory Apr 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sdmg15 commented May 5, 2025

Uh oh!

oleonardolima left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sdmg15 commented May 21, 2025

Uh oh!

oleonardolima commented May 23, 2025

Uh oh!

notmandatory commented May 28, 2025

Uh oh!

oleonardolima commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sdmg15 commented Jun 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sdmg15 commented Jun 12, 2025

Uh oh!

tvpeter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

notmandatory Apr 26, 2025 •

edited

Loading

oleonardolima commented Jun 5, 2025 •

edited

Loading

sdmg15 commented Jun 5, 2025 •

edited

Loading